home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / dev / gui / BGUI11c.lha / docs / buttonclass.doc < prev    next >
Text File  |  1995-04-23  |  2KB  |  74 lines
  1.  
  2.                File: buttonclass.doc
  3.         Description: Buttonclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. buttonclass/--background--
  13. buttonclass/Methods
  14. buttonclass/Attributes
  15.  
  16. buttonclass/--background--                          buttonclass/--background--
  17.  
  18.     NAME
  19.         Class:          buttonclass
  20.         Superclass:     baseclass
  21.         Include File:   <llibraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To provide a gadget simular to the gadtools.library button  kind.  The
  25.         gadget can either be a normal button or a toggle button.   Vectorclass
  26.         attributes can be passed at create time to add imagery to the gadget.
  27.  
  28.         The  gadget  will  send  the following attributes in it's notification
  29.         events:
  30.  
  31.         GA_ID           - Gadget object ID.
  32.         GA_UserData     - Gadget object userdata contents.
  33.         GA_Selected     - Gadget object selected state.
  34.  
  35.         Please  note  that  the  gadget  will  send  out  interim notification
  36.         messages every single timer tick while the gadget is selected.
  37.  
  38. buttonclass/Methods                                        buttonclass/Methods
  39.  
  40.     NEW METHODS
  41.         None.
  42.  
  43.     CHANGED METHODS
  44.         None.
  45.  
  46. buttonclass/Attributes                                  buttonclass/Attributes
  47.  
  48.     NOTE: The  VIT_VectorArray  and  VIT_BuiltIn  attributes are also settable
  49.           with OM_SET or OM_UPDATE.
  50.  
  51.     NAME
  52.         GA_Selected - ( BOOL )
  53.  
  54.     FUNCTION
  55.         This  attributes  has  an  extended  applicability.  It  has been made
  56.         get-able  to  make  it  easy to inquire about the selected state of an
  57.         object.
  58.  
  59.         Default is FALSE. Applicability is (ISGNU).
  60.  
  61.     NAME
  62.         BUTTON_Image, BUTTON_SelectedImage -- ( struct Image * )
  63.  
  64.     FUNCTION
  65.         To provide a button object width a standard Intuition or BOOPSI image.
  66.         The images will be centered  inside the object  it's hitbox.  You  can
  67.         supply a selected image which is  shown when  the gadget  is selected.
  68.         If no selected imagery is  specified  the normal  image is  also shown
  69.         when the gadget is selected.
  70.  
  71.         This attribute overides the creation of a VectorClass image.
  72.  
  73.         Defaults are NULL. Applicability is (I).
  74.